<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Table Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">Table Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Presents data from a data set in using a tabular layout.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Table</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>table</code></td></tr>
<tr><td>Extends:</td>
<td><a href="Listing.html">Listing</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Report Items</td></tr>
<tr><td>Name Requirement:</td>
<td>Optional</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>Yes</td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#table">table</a></td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-caption">caption</a></dt>
<dd>Text to appear as a table caption in HTML.</dd>
<dt><a href="#Property-captionID">captionID</a></dt>
<dd></dd>
<dt><a href="#Property-isSummaryTable">isSummaryTable</a></dt>
<dd></dd>
<dt><a href="#Property-summary">summary</a></dt>
<dd></dd>
</dl>

<h3>Method Summary</h3>

<dl class="section-text">
<dt><a href="#Method-onCreate">onCreate</a></dt>
<dd>Script executed when the element is created in the Factory.</dd>
<dt><a href="#Method-onPageBreak">onPageBreak</a></dt>
<dd></dd>
<dt><a href="#Method-onPrepare">onPrepare</a></dt>
<dd>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</dd>
<dt><a href="#Method-onRender">onRender</a></dt>
<dd>Script executed when the element is prepared for rendering in the Presentation engine.</dd>
</dl>

<h3>Slot Summary</h3>

<dl class="section-text">
<dt><a href="#Slot-header">header</a></dt>
<dd>Rows to appear at the top of the table, and 
optionally at the top of each page.</dd>
<dt><a href="#Slot-groups">groups</a></dt>
<dd>Level breaks within the data. Each has its own header 
&amp; footer.</dd>
<dt><a href="#Slot-detail">detail</a></dt>
<dd>Rows to display for each row in the data set.</dd>
<dt><a href="#Slot-footer">footer</a></dt>
<dd>Rows to appear at the bottom of the table.</dd>
<dt><a href="#Slot-columns">columns</a></dt>
<dd>A list of Column elements that describe the table 
columns.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportItem.html#Property-ACLExpression">ACLExpression</a>, 
<a href="ReportItem.html#Property-allowExport">allowExport</a>, 
<a href="ReportItem.html#Property-bookmark">bookmark</a>, 
<a href="ReportItem.html#Property-bookmarkDisplayName">bookmarkDisplayName</a>, 
<a href="ReportItem.html#Property-boundDataColumns">boundDataColumns</a>, 
<a href="ReportItem.html#Property-cascadeACL">cascadeACL</a>, 
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="ReportItem.html#Property-cube">cube</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportItem.html#Property-dataBindingRef">dataBindingRef</a>, 
<a href="ReportItem.html#Property-dataSet">dataSet</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="Listing.html#Property-filter">filter</a>, 
<a href="ReportItem.html#Property-height">height</a>, 
<a href="ReportItem.html#Property-multiViews">multiViews</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="Listing.html#Property-pageBreakInterval">pageBreakInterval</a>, 
<a href="ReportItem.html#Property-paramBindings">paramBindings</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="ReportItem.html#Property-pushDown">pushDown</a>, 
<a href="ReportItem.html#Property-refTemplateParameter">refTemplateParameter</a>, 
<a href="Listing.html#Property-repeatHeader">repeatHeader</a>, 
<a href="Listing.html#Property-sort">sort</a>, 
<a href="Listing.html#Property-sortByGroups">sortByGroups</a>, 
<a href="ReportItem.html#Property-style">style</a>, 
<a href="ReportItem.html#Property-toc">toc</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>, 
<a href="ReportItem.html#Property-visibility">visibility</a>, 
<a href="ReportItem.html#Property-width">width</a>, 
<a href="ReportItem.html#Property-x">x</a>, 
<a href="ReportItem.html#Property-y">y</a>, 
<a href="ReportItem.html#Property-zIndex">zIndex</a>
</p>
<h3>Style Properties</h3>

<p class="section-text">
<a href="Style.html#Property-backgroundAttachment">backgroundAttachment</a>, 
<a href="Style.html#Property-backgroundColor">backgroundColor</a>, 
<a href="Style.html#Property-backgroundImage">backgroundImage</a>, 
<a href="Style.html#Property-backgroundPositionX">backgroundPositionX</a>, 
<a href="Style.html#Property-backgroundPositionY">backgroundPositionY</a>, 
<a href="Style.html#Property-backgroundRepeat">backgroundRepeat</a>, 
<a href="Style.html#Property-backgroundSizeHeight">backgroundSizeHeight</a>, 
<a href="Style.html#Property-backgroundSizeWidth">backgroundSizeWidth</a>, 
<a href="Style.html#Property-bidiTextDirection">bidiTextDirection</a>, 
<a href="Style.html#Property-borderBottomColor">borderBottomColor</a>, 
<a href="Style.html#Property-borderBottomStyle">borderBottomStyle</a>, 
<a href="Style.html#Property-borderBottomWidth">borderBottomWidth</a>, 
<a href="Style.html#Property-borderLeftColor">borderLeftColor</a>, 
<a href="Style.html#Property-borderLeftStyle">borderLeftStyle</a>, 
<a href="Style.html#Property-borderLeftWidth">borderLeftWidth</a>, 
<a href="Style.html#Property-borderRightColor">borderRightColor</a>, 
<a href="Style.html#Property-borderRightStyle">borderRightStyle</a>, 
<a href="Style.html#Property-borderRightWidth">borderRightWidth</a>, 
<a href="Style.html#Property-borderTopColor">borderTopColor</a>, 
<a href="Style.html#Property-borderTopStyle">borderTopStyle</a>, 
<a href="Style.html#Property-borderTopWidth">borderTopWidth</a>, 
<a href="Style.html#Property-canShrink">canShrink</a>, 
<a href="Style.html#Property-color">color</a>, 
<a href="Style.html#Property-dateFormat">dateFormat</a>, 
<a href="Style.html#Property-dateTimeFormat">dateTimeFormat</a>, 
<a href="Style.html#Property-display">display</a>, 
<a href="Style.html#Property-fontFamily">fontFamily</a>, 
<a href="Style.html#Property-fontSize">fontSize</a>, 
<a href="Style.html#Property-fontStyle">fontStyle</a>, 
<a href="Style.html#Property-fontVariant">fontVariant</a>, 
<a href="Style.html#Property-fontWeight">fontWeight</a>, 
<a href="Style.html#Property-highlightRules">highlightRules</a>, 
<a href="Style.html#Property-letterSpacing">letterSpacing</a>, 
<a href="Style.html#Property-lineHeight">lineHeight</a>, 
<a href="Style.html#Property-mapRules">mapRules</a>, 
<a href="Style.html#Property-marginBottom">marginBottom</a>, 
<a href="Style.html#Property-marginLeft">marginLeft</a>, 
<a href="Style.html#Property-marginRight">marginRight</a>, 
<a href="Style.html#Property-marginTop">marginTop</a>, 
<a href="Style.html#Property-masterPage">masterPage</a>, 
<a href="Style.html#Property-numberAlign">numberAlign</a>, 
<a href="Style.html#Property-numberFormat">numberFormat</a>, 
<a href="Style.html#Property-orphans">orphans</a>, 
<a href="Style.html#Property-paddingBottom">paddingBottom</a>, 
<a href="Style.html#Property-paddingLeft">paddingLeft</a>, 
<a href="Style.html#Property-paddingRight">paddingRight</a>, 
<a href="Style.html#Property-paddingTop">paddingTop</a>, 
<a href="Style.html#Property-pageBreakAfter">pageBreakAfter</a>, 
<a href="Style.html#Property-pageBreakBefore">pageBreakBefore</a>, 
<a href="Style.html#Property-pageBreakInside">pageBreakInside</a>, 
<a href="Style.html#Property-showIfBlank">showIfBlank</a>, 
<a href="Style.html#Property-stringFormat">stringFormat</a>, 
<a href="Style.html#Property-textAlign">textAlign</a>, 
<a href="Style.html#Property-textIndent">textIndent</a>, 
<a href="Style.html#Property-textLineThrough">textLineThrough</a>, 
<a href="Style.html#Property-textOverline">textOverline</a>, 
<a href="Style.html#Property-textTransform">textTransform</a>, 
<a href="Style.html#Property-textUnderline">textUnderline</a>, 
<a href="Style.html#Property-timeFormat">timeFormat</a>, 
<a href="Style.html#Property-verticalAlign">verticalAlign</a>, 
<a href="Style.html#Property-whiteSpace">whiteSpace</a>, 
<a href="Style.html#Property-widows">widows</a>, 
<a href="Style.html#Property-wordSpacing">wordSpacing</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>A table presents the rows from a data set in a tabular 
arrangement. The columns property is optional and defines the columns. The 
header appears at the top of the table, and on each new page. The table can 
contain groups. The footer displays totals and appears at the bottom of the 
table. The detail appears for every row in the data set.</p>

<p>A table can omit the data set. In this case, it displays 
a set of rows defined by its container. See the &quot;Combining a List and a Table 
with a Single Data Set&quot; section below for details.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-caption">caption Property</a></h2>

<p class="section-text">Text to appear as a table caption in HTML.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Caption</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>This property provides text to appear as the table 
caption in HTML. The text can be localized. From the HTML 4.0 spec:</p>
<p>When present, the CAPTION element's text should describe the 
nature of the table. ? Visual user agents allow sighted people to quickly grasp 
the structure of the table from the headings as well as the caption. A 
consequence of this is that captions will often be inadequate as a summary of 
the purpose and structure of the table from the perspective of people relying on 
non-visual user agents.</p></div>

<hr>
<h2><a name="Property-captionID">captionID Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Caption key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-isSummaryTable">isSummaryTable Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is summary table</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-summary">summary Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.3</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Summary</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h1>Method Detail</h1>

<h2><a name="Method-onCreate">onCreate Method</a></h2>

<p class="section-text">Script executed when the element is created in the Factory.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onCreate(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Executed when the element is created in the Factory. Called after the item is created, but before 
the item is saved to the report document file. See the scripting spec for additional information 
about this script. Applications should perform visual customization in the on-render script instead.</p></div>

<hr>
<h2><a name="Method-onPageBreak">onPageBreak Method</a></h2>

<p class="section-text"></p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPageBreak(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Context:</td>
<td>presentation</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>


<hr>
<h2><a name="Method-onPrepare">onPrepare Method</a></h2>

<p class="section-text">It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPrepare(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Context:</td>
<td>startup</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p></div>

<hr>
<h2><a name="Method-onRender">onRender Method</a></h2>

<p class="section-text">Script executed when the element is prepared for rendering in the Presentation engine.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onRender(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>presentation</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Executed when the element is prepared for rendering in the Presentation engine. Changes made to the 
element are written to the target output format, but not saved to the report document file. This is the
preferred place for visual customizations.</p></div>
<h1>Slot Detail</h1>

<h2><a name="Slot-header">header Slot</a></h2>

<p class="section-text">Rows to appear at the top of the table, and 
optionally at the top of each page.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Header</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>header</code></td></tr>
<tr><td>Contents:</td>
<td>List of <a href="Row.html">Row</a></td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#table-header">table-header</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The table header appears at the top of the table, and 
optionally at the top of each page. The table header usually contains column 
headings. Unlike a list, the table header is not designed to display 
introductory information. Instead, to display such information, use the table 
combined with a list as described in the &quot;Combining a List and a Table with a 
Single Data Set&quot; section below.</p></div>

<hr>
<h2><a name="Slot-groups">groups Slot</a></h2>

<p class="section-text">Level breaks within the data. Each has its own header 
&amp; footer.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Groups</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td>None. (The contents appear directly within the container element.)</td></tr>
<tr><td>Contents:</td>
<td>List of <a href="TableGroup.html">TableGroup</a></td></tr>
<tr><td>Default Style:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Groups provide a way of organizing data within a table. 
Groups appear from the most general (outermost) to the most specific 
(innermost). For example, a table can display sales by sales region and sales rep. The region 
and rep represent groups. The region is the outermost group. The rep is the 
innermost group.</p></div>

<hr>
<h2><a name="Slot-detail">detail Slot</a></h2>

<p class="section-text">Rows to display for each row in the data set.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Detail</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>detail</code></td></tr>
<tr><td>Contents:</td>
<td>List of <a href="Row.html">Row</a></td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#table-detail">table-detail</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The detail rows appear for each row in the data set. Rows 
can be conditionally selected. For example, an accounting report can display a 
different row for debits vs. credits.</p></div>

<hr>
<h2><a name="Slot-footer">footer Slot</a></h2>

<p class="section-text">Rows to appear at the bottom of the table.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Footer</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>footer</code></td></tr>
<tr><td>Contents:</td>
<td>List of <a href="Row.html">Row</a></td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#table-footer">table-footer</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The footer defines a set of rows to appear at the bottom 
of a table. The footer often contains totals.</p></div>

<hr>
<h2><a name="Slot-columns">columns Slot</a></h2>

<p class="section-text">A list of Column elements that describe the table 
columns.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Columns</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td>None. (The contents appear directly within the container element.)</td></tr>
<tr><td>Contents:</td>
<td>List of <a href="Column.html">Column</a></td></tr>
<tr><td>Default Style:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>This slot describes the columns within the table. 
This column definitions are optional. If omitted, BIRT infers the columns from the table 
structure itself, and BIRT will size the columns based on their contents. If 
provided, then the table must contain no more than the number of columns 
described. Use this property when you want to control the size, color, border, 
or other properties of each column.</p></div>
<h3>See Also</h3>

<div class="section-text">
The Column Definition structure in the <i>ROM Layout 
Specification</i>.</div>
</body>
</html>
